Expere Developer Guide
Expere Developer Guide
  • Overview
  • Getting Started
    • Accessing the Expere API
    • Authorization and Authentication
    • Error Handling and Messaging
    • Installation and Deployment
  • Implementation Strategies
    • Transaction Persistence (Saving Transaction Data)
    • Document Output Formats (DocumentFormat)
    • Document Representations (DocumentSet and DocSet)
      • PackageDoc (PKGD)
    • Ancillary Outputs (Post-Processing)
      • Barcodes
      • Watermarks
      • Encryption
      • Using eSignature and Acroform fields
      • Signature Points
      • RequestUCD flag - PDF/A
    • RequestUCD flag - PDF/A
    • MergeTRIDDocs flag - PDF
    • Processing a Transaction with AutoSelection
    • Processing a Transaction without AutoSelection
    • API Scenarios
      • One-Step Scenario: SelectAndGenerate
      • Two-Step Scenario: Select and Generate methods
  • ExpereAPI Service
    • AddDocuments
      • AddDocumentsRequest
      • AddDocumentsResponse
    • AddOrganization
      • AddOrganizationRequest
      • AddOrganizationResponse
    • ApplyPoliciesAndReturnTransaction
      • ApplyPoliciesAndReturnTransactionRequest
      • ApplyPoliciesAndReturnTransactionResponse
    • AssembleDocuments
      • AssembleDocumentsRequest
      • AssembleDocumentsResponse
    • AssembleDocumentSet
      • AssembleDocumentSetRequest
      • AssembleDocumentSetResponse
    • AutoSelect
      • AutoSelectRequest
      • AutoSelectResponse
    • ClearCache
      • ClearCacheRequest
      • ClearCacheResponse
    • Compile
      • CompileRequest
      • CompileResponse
    • CompileAll
      • CompileAllRequest
      • CompileAllResponse
    • CreateOppsaPhase
      • CreateOppsaPhaseRequest
      • CreateOppsaPhaseResponse
    • CreateOppsaPolicyOrganization
      • CreateOppsaPolicyOrganizationRequest
      • CreateOppsaPolicyOrganizationResponse
    • CreateTransaction
      • CreateTransactionRequest
      • CreateTransactionResponse
    • DeleteOrganization
      • DeleteOrganizationRequest
      • DeleteOrganizationResponse
    • DeleteTransaction
      • DeleteTransactionRequest
      • DeleteTransactionResponse
    • Echo
    • Generate
      • GenerateRequest
      • GenerateResponse
    • GenerateAndSave
      • GenerateAndSaveRequest
      • GenerateAndSaveResponse
    • GetDocDataRequirements
      • GetDocDataRequirementsRequest
      • GetDocDataRequirementsResponse
    • GetDocSetDataRequirements
      • GetDocSetDataRequirementsRequest
      • GetDocSetDataRequirementsResponse
    • GetDocumentSet
      • GetDocumentSetRequest
      • GetDocumentSetResponse
    • GetPackageDataRequirements
      • GetPackageDataRequirementsRequest
      • GetPackageDataRequirementsResponse
    • GetResolvedDocuments
      • GetResolvedDocumentsRequest
      • GetResolvedDocumentsResponse
    • GetResolvedPackage
      • GetResolvedPackageRequest
      • GetResolvedPackageResponse
    • GetServiceInfo
      • GetServiceInfoRequest
      • GetServiceInfoResponse
    • GetTransaction
      • GetTransactionRequest
      • GetTransactionResponse
    • ListAllDocuments
      • ListAllDocumentsRequest
      • ListAllDocumentsResponse
    • ListAllOrganizations
      • ListAllOrganizationsRequest
      • ListAllOrganizationsResponse
    • ListDocuments
      • ListDocumentsRequest
      • ListDocumentsResponse
    • ListLinesOfBusiness
      • ListLinesOfBusinessRequest
      • ListLinesOfBusinessResponse
    • ListOrganizations
      • ListOrganizationsRequest
      • ListOrganizationsResponse
    • ListPackages
      • ListPackagesRequest
      • ListPackagesResponse
    • ListPhases
      • ListPhasesRequest
      • ListPhasesResponse
    • ListPolicies
      • ListPoliciesRequest
      • ListPoliciesResponse
    • PostProcess
      • PostProcessRequest
      • PostProcessResponse
    • RemoveDocuments
      • RemoveDocumentsRequest
      • RemoveDocumentsResponse
    • ResolveDocData
      • ResolveDocDataRequest
      • ResolveDocDataResponse
    • ResolvePkgData
      • ResolvePkgDataRequest
      • ResolvePkgDataResponse
    • Select
      • SelectRequest
      • SelectResponse
    • SelectAndGenerate
      • SelectAndGenerateRequest
      • SelectAndGenerateResponse
    • SelectAndGenerateTestDocuments
      • SelectAndGenerateTestDocumentsRequest
      • SelectAndGenerateTestDocumentsResponse
    • SelectGenerateAndSave
      • SelectGenerateAndSaveRequest
      • SelectGenerateAndSaveResponse
    • UpdateTransaction
      • UpdateTransactionRequest
      • UpdateTransactionResponse
  • ExpereAPI Service - Integration Validation Operations
    • CreateValidationWorksheet
      • CreateValidationWorksheetRequest
      • CreateValidationWorksheetResponse
    • DeleteValidationTransaction
      • DeleteValidationTransactionRequest
      • DeleteValidationTransactionResponse
    • GetValidationTransaction
      • GetValidationTransactionRequest
      • GetValidationTransactionResponse
    • ListValidationTransactions
      • ListValidationTransactionsRequest
      • ListValidationTransactionsResponse
    • UpdateValidationComments
      • UpdateValidationCommentsRequest
      • UpdateValidationCommentsResponse
    • UpdateValidationDictionaryDefinitions
      • UpdateValidationDictionaryDefinitionsRequest
      • UpdateValidationDictionaryDefinitionsResponse
    • UploadValidationTransaction
      • UploadValidationTransactionRequest
      • UploadValidationTransactionResponse
    • XpathCompare
      • XpathCompareRequest
      • XpathCompareResponse
  • Data Types
    • ArrayOfAncillaryOutputOption
    • ArrayOfCache
    • ArrayOfDatabase
    • ArrayOfDocCustomDataItem
    • ArrayOfDocument
    • ArrayOfExpereMessage
    • ArrayOfExpereObject
    • ArrayOfKey
    • ArrayOfLibrary
    • ArrayOfLineOfBusiness
    • ArrayOfOrganization
    • ArrayOfPackage
    • ArrayOfPackageDoc
    • ArrayOfPDF
    • ArrayOfPolicy
    • ArrayOfSBAAgent
    • ArrayOfThirdPartyLibrary
    • ArrayOfTransaction
    • AncillaryOutputOption
    • AncillaryOutputType
    • AncillaryOutputTypeEnum
    • Barcode2DConfigOptions
    • Barcode
    • BarcodeType
    • BarcodeTypeEnum
    • BaselineTransaction
    • BeginningOrEndEnum
    • bsi_properties
    • cache
    • CommentInformation
    • CustomerTransaction
    • Data
    • Data
    • Database
    • DataItems
    • DataItem
    • defaultCache
    • DiscretePartyID
    • diskStore
    • DocCustomDataItem
    • DocDescriptor
    • DocInstance
    • DocSet
    • DocSetSummary
    • Document
    • DocumentFormatType
    • DocumentFormatTypeEnum
    • DocumentRef
    • DocumentRefs
    • DocumentSet
    • DocumentType
    • DocumentTypeEnum
    • DocWorkOrder
    • DynamicPdfRender
    • DynamicPdfRenderEnum
    • ehcache
    • ESignatureAndFieldSupport
    • EnvironmentInformation
    • ExecuteMode
    • ExecuteModeEnum
    • ExpereBoolean
    • ExpereFloat
    • ExpereInteger
    • ExpereMessage
    • ExpereObject
    • ExternalPDFDocuments
    • FillableCheckbox
    • FillableField
    • FillableFieldSet
    • FillableText
    • HorizontalAlignmentEnum
    • InlinePackage
    • InlinePackageDocs
    • InlinePackageDoc
    • InstanceFormattingMetadata
    • InstanceSigningInstructionsType
    • InstanceSigningInstructionsTypeEnum
    • Key
    • Library
    • LineOfBusiness
    • LOBPhase
    • Oppsa
    • Options
    • Organization
    • Package
    • PackageDoc
    • Packet
    • PacketCustomDataItem
    • PacketCustomDataItems
    • PacketTypes
    • PacketType
    • Passwords
    • PDF
    • Permissions
    • Phase
    • Phases
    • Policies
    • Policy
    • Product
    • ProvidedDocument
    • ProvidedDocuments
    • RequirementLevel
    • RequirementLevelEnum
    • ResponseDocType
    • ResponseDocTypeEnum
    • SBAAgent
    • SetEncryption
    • SignaturePoint
    • SignaturePoints
    • SignaturePointSet
    • Signer
    • TermType
    • ThirdPartyLibrary
    • Transaction
    • Transaction
    • Values
    • Watermark
    • WatermarkLocation
    • WatermarkLocationEnum
    • XpathCompare
  • Appendix A: Font Scaling Adjustments Stylesheet Details
Index
  1. Home
  2. Implementation Strategies
  3. API Scenarios

API Scenarios

This section offers two typical scenarios used to assemble documents. They are provided not as procedures, but as possible situations that contain examples of how and when to use the most common API methods.
  • One-Step Scenario: Using the SelectAndGenerate method.
  • Two-Step Scenario: Using the Select and Generate methods independently.
  • Implementation Strategies
    • Transaction Persistence (Saving Transaction Data)
    • Document Output Formats (DocumentFormat)
    • Document Representations (DocumentSet and DocSet)
    • Ancillary Outputs (Post-Processing)
    • RequestUCD flag - PDF/A
    • MergeTRIDDocs flag - PDF
    • Processing a Transaction with AutoSelection
    • Processing a Transaction without AutoSelection
    • API Scenarios
      • One-Step Scenario: SelectAndGenerate
      • Two-Step Scenario: Select and Generate methods